/*
 * Copyright 2004 original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jbfilter.core;

import java.util.Calendar;

/**
 * The precision unit used for date truncation.
 * @author Marcus Adrian
 */
public enum TruncateUnit {
	MILLISECOND(Calendar.MILLISECOND),
	SECOND(Calendar.SECOND),
	MINUTE(Calendar.MINUTE),
	HOUR(Calendar.HOUR),
	DAY(Calendar.DAY_OF_MONTH),
	YEAR(Calendar.YEAR);
	
	private int calConst;

	private TruncateUnit(int calConst) {
		this.calConst = calConst;
	}
	/**
	 * The corresponding constant from the {@link Calendar} class.
	 * @return
	 */
	public int getCalConst() {
		return calConst;
	}
}
